home *** CD-ROM | disk | FTP | other *** search
/ C/C++ Users Group Library 1996 July / C-C++ Users Group Library July 1996.iso / vol_300 / 367_01 / futi14as.zoo / getopt.c < prev    next >
C/C++ Source or Header  |  1990-08-22  |  17KB  |  592 lines
  1. /* Getopt for GNU.
  2.    Copyright (C) 1987, 1989, 1990 Free Software Foundation, Inc.
  3.  
  4.    This program is free software; you can redistribute it and/or modify
  5.    it under the terms of the GNU General Public License as published by
  6.    the Free Software Foundation; either version 1, or (at your option)
  7.    any later version.
  8.  
  9.    This program is distributed in the hope that it will be useful,
  10.    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11.    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12.    GNU General Public License for more details.
  13.  
  14.    You should have received a copy of the GNU General Public License
  15.    along with this program; if not, write to the Free Software
  16.    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
  17.  
  18. #ifdef __STDC__
  19. #define CONST const
  20. #else
  21. #define CONST
  22. #endif
  23.  
  24. /* This version of `getopt' appears to the caller like standard Unix `getopt'
  25.    but it behaves differently for the user, since it allows the user
  26.    to intersperse the options with the other arguments.
  27.  
  28.    As `getopt' works, it permutes the elements of `argv' so that,
  29.    when it is done, all the options precede everything else.  Thus
  30.    all application programs are extended to handle flexible argument order.
  31.  
  32.    Setting the environment variable _POSIX_OPTION_ORDER disables permutation.
  33.    Then the behavior is completely standard.
  34.  
  35.    GNU application programs can use a third alternative mode in which
  36.    they can distinguish the relative order of options and other arguments.  */
  37.  
  38. #include <stdio.h>
  39.  
  40. /* If compiled with GNU C, use the built-in alloca */
  41. #ifdef __GNUC__
  42. #define alloca __builtin_alloca
  43. #else /* not __GNUC__ */
  44. #ifdef sparc
  45. #include <alloca.h>
  46. #else
  47. char *alloca ();
  48. #endif
  49. #endif /* not __GNUC__ */
  50.  
  51. #if defined(STDC_HEADERS) || defined(__GNU_LIBRARY__)
  52. #include <stdlib.h>
  53. #include <string.h>
  54. #define bcopy(s, d, n) memcpy ((d), (s), (n))
  55. #define index strchr
  56. #else
  57.  
  58. #ifdef USG
  59. #include <string.h>
  60. #define bcopy(s, d, n) memcpy ((d), (s), (n))
  61. #define index strchr
  62. #else
  63. #include <strings.h>
  64. void bcopy ();
  65. #endif
  66.  
  67. char *getenv ();
  68. char *malloc ();
  69. #endif
  70.  
  71. /* For communication from `getopt' to the caller.
  72.    When `getopt' finds an option that takes an argument,
  73.    the argument value is returned here.
  74.    Also, when `ordering' is RETURN_IN_ORDER,
  75.    each non-option ARGV-element is returned here.  */
  76.  
  77. char *optarg = 0;
  78.  
  79. /* Index in ARGV of the next element to be scanned.
  80.    This is used for communication to and from the caller
  81.    and for communication between successive calls to `getopt'.
  82.  
  83.    On entry to `getopt', zero means this is the first call; initialize.
  84.  
  85.    When `getopt' returns EOF, this is the index of the first of the
  86.    non-option elements that the caller should itself scan.
  87.  
  88.    Otherwise, `optind' communicates from one call to the next
  89.    how much of ARGV has been scanned so far.  */
  90.  
  91. int optind = 0;
  92.  
  93. /* The next char to be scanned in the option-element
  94.    in which the last option character we returned was found.
  95.    This allows us to pick up the scan where we left off.
  96.  
  97.    If this is zero, or a null string, it means resume the scan
  98.    by advancing to the next ARGV-element.  */
  99.  
  100. static char *nextchar;
  101.  
  102. /* Callers store zero here to inhibit the error message
  103.    for unrecognized options.  */
  104.  
  105. int opterr = 1;
  106.  
  107. /* Describe how to deal with options that follow non-option ARGV-elements.
  108.  
  109.    If the caller did not specify anything,
  110.    the default is REQUIRE_ORDER if the environment variable
  111.    _POSIX_OPTION_ORDER is defined, PERMUTE otherwise.
  112.  
  113.    REQUIRE_ORDER means don't recognize them as options;
  114.    stop option processing when the first non-option is seen.
  115.    This is what Unix does.
  116.    This mode of operation is selected by either setting the environment
  117.    variable _POSIX_OPTION_ORDER, or using `+' as the first character
  118.    of the list of option characters.
  119.  
  120.    PERMUTE is the default.  We permute the contents of ARGV as we scan,
  121.    so that eventually all the non-options are at the end.  This allows options
  122.    to be given in any order, even with programs that were not written to
  123.    expect this.
  124.  
  125.    RETURN_IN_ORDER is an option available to programs that were written
  126.    to expect options and other ARGV-elements in any order and that care about
  127.    the ordering of the two.  We describe each non-option ARGV-element
  128.    as if it were the argument of an option with character code 1.
  129.    Using `-' as the first character of the list of option characters
  130.    selects this mode of operation.
  131.  
  132.    The special argument `--' forces an end of option-scanning regardless
  133.    of the value of `ordering'.  In the case of RETURN_IN_ORDER, only
  134.    `--' can cause `getopt' to return EOF with `optind' != ARGC.  */
  135.  
  136. static enum
  137. {
  138.   REQUIRE_ORDER, PERMUTE, RETURN_IN_ORDER
  139. } ordering;
  140.  
  141. /* Describe the long-named options requested by the application.
  142.    _GETOPT_LONG_OPTIONS is a vector of `struct option' terminated by an
  143.    element containing a name which is zero.
  144.    The field `has_arg' is 1 if the option takes an argument,
  145.    2 if it takes an optional argument.  */
  146.  
  147. struct option
  148. {
  149.   char *name;
  150.   int has_arg;
  151.   int *flag;
  152.   int val;
  153. };
  154.  
  155. CONST struct option *_getopt_long_options;
  156.  
  157. int _getopt_long_only = 0;
  158.  
  159. /* Index in _GETOPT_LONG_OPTIONS of the long-named option actually found.
  160.    Only valid when a long-named option was found. */
  161.  
  162. int option_index;
  163.  
  164. /* Handle permutation of arguments.  */
  165.  
  166. /* Describe the part of ARGV that contains non-options that have
  167.    been skipped.  `first_nonopt' is the index in ARGV of the first of them;
  168.    `last_nonopt' is the index after the last of them.  */
  169.  
  170. static int first_nonopt;
  171. static int last_nonopt;
  172.  
  173. /* Exchange two adjacent subsequences of ARGV.
  174.    One subsequence is elements [first_nonopt,last_nonopt)
  175.     which contains all the non-options that have been skipped so far.
  176.    The other is elements [last_nonopt,optind), which contains all
  177.     the options processed since those non-options were skipped.
  178.  
  179.    `first_nonopt' and `last_nonopt' are relocated so that they describe
  180.     the new indices of the non-options in ARGV after they are moved.  */
  181.  
  182. static void
  183. exchange (argv)
  184.      char **argv;
  185. {
  186.   int nonopts_size = (last_nonopt - first_nonopt) * sizeof (char *);
  187.   char **temp = (char **) alloca (nonopts_size);
  188.  
  189.   /* Interchange the two blocks of data in ARGV.  */
  190.  
  191.   bcopy (&argv[first_nonopt], temp, nonopts_size);
  192.   bcopy (&argv[last_nonopt], &argv[first_nonopt],
  193.      (optind - last_nonopt) * sizeof (char *));
  194.   bcopy (temp, &argv[first_nonopt + optind - last_nonopt], nonopts_size);
  195.  
  196.   /* Update records for the slots the non-options now occupy.  */
  197.  
  198.   first_nonopt += (optind - last_nonopt);
  199.   last_nonopt = optind;
  200. }
  201.  
  202. /* Scan elements of ARGV (whose length is ARGC) for option characters
  203.    given in OPTSTRING.
  204.  
  205.    If an element of ARGV starts with '-', and is not exactly "-" or "--",
  206.    then it is an option element.  The characters of this element
  207.    (aside from the initial '-') are option characters.  If `getopt'
  208.    is called repeatedly, it returns successively each of the option characters
  209.    from each of the option elements.
  210.  
  211.    If `getopt' finds another option character, it returns that character,
  212.    updating `optind' and `nextchar' so that the next call to `getopt' can
  213.    resume the scan with the following option character or ARGV-element.
  214.  
  215.    If there are no more option characters, `getopt' returns `EOF'.
  216.    Then `optind' is the index in ARGV of the first ARGV-element
  217.    that is not an option.  (The ARGV-elements have been permuted
  218.    so that those that are not options now come last.)
  219.  
  220.    OPTSTRING is a string containing the legitimate option characters.
  221.    If an option character is seen that is not listed in OPTSTRING,
  222.    return '?' after printing an error message.  If you set `opterr' to
  223.    zero, the error message is suppressed but we still return '?'.
  224.  
  225.    If a char in OPTSTRING is followed by a colon, that means it wants an arg,
  226.    so the following text in the same ARGV-element, or th